docs: reconcile package docs and articles with current behavior#334
Merged
Conversation
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation truth sweep across the nuget package READMEs, the docfx articles, shipped XML doc comments, and nuget package metadata — every claim reconciled against current behavior on main. No code-behavior changes.
IOutboxStore/RelationalOutboxStore<TContext>), a two-type-parameterAddHttpMockoverload, and a per-consumerBindrouting override (real knob:UseRetry; bindings are per-queueSubscribe).MaxRetriesdead-letters viaFailedOnUtc; request logging covers onlyResult-returning requests; the test harness retries a throwing consumer and publishes a capturedFault<T>instead of propagating; inbox retry bounding is per-consumer policy, not a queueMaxRetryCount; entity-id examples use records for value equality.Fault<T>);IIdempotencyStorecontext/token semantics;BaseDbContext's unconditionalOutboxMessagemapping and theIgnore<OutboxMessage>()opt-out; HTTP mapping response bodies end-to-end (RFC 7807 details, 404/409 problem bodies, typed-union nuance).UseMySqlon both target frameworks,GetResponseAsync) and fix wrong property docs.Vulthil.Extensions.Hostinga docs article andVulthil.Extensions.Testingan accurate identity; complete the package index and getting-started tables (nine packages were unlisted); standardize README links on the documentation site root (the site publishes only versioned slugs, so unversioned deep links 404 and pinned ones rot on pruning) and satellite cross-links on relative in-site links.shared-kernel;ddd;cqrs;result-pattern;dotneton all 24 packages) with per-package tags describing each package's actual contents, and alignVulthil.Extensions.Testing's package description with its real surface.Verification
TreatWarningsAsErrors), so all XML doc edits compile.docfx docs/docfx.json(same invocation as the docs workflow) builds with 0 warnings / 0 errors — all links, anchors, and the new article/toc wiring resolve.dotnet packspot-check confirms the per-package tags land in the generated nuspec.Backport to v1.0: no — docs republish with the next release; the main docs slug updates immediately on merge.